Skip to main content
POST
/
metric
/
placements
Get a placement metric
curl --request POST \
  --url https://your_a2_service/metric/placements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "from_datetime": "2023-11-07T05:31:56Z",
  "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_datetime": "2023-11-07T05:31:56Z"
}'
{
  "active_campaigns": 0,
  "ad_revenue": 123,
  "budget_spent": 0,
  "click": 0,
  "conversion": 0,
  "ecpm": 0,
  "id": 123,
  "impression": 0,
  "reach": 0,
  "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Query model for retrieving placement metrics.

tagid
string<uuid>
required

The placement ID to query metrics for

from_datetime
string<date-time> | null

Start date and time for the metrics query range

to_datetime
string<date-time> | null

End date and time for the metrics query range

Response

Successful Response

Schema for placement metric entity.

ad_revenue
number
required

Ad Revenue

id
integer
required
tagid
string<uuid>
required

The placement ID

active_campaigns
integer
default:0

Number of active campaigns on the placement

budget_spent
number
default:0

Budget spent

click
integer
default:0

Click

conversion
integer
default:0

Conversion

ecpm
number
default:0

Effective Cost Per Mille

impression
integer
default:0

Impression

reach
integer
default:0

Reach